check mkdocs build strict in CI#1360
Merged
kevinjqliu merged 3 commits intoapache:mainfrom Nov 22, 2024
Merged
Conversation
Fokko
reviewed
Nov 21, 2024
Contributor
Fokko
left a comment
Fokko
left a comment
There was a problem hiding this comment.
Good one to check, I left some suggestions. Let me know what you think!
kevinjqliu
force-pushed
the
kevinjqliu/ci-check-mkdoc
branch
from
021e363 to
aec8823
Compare
kevinjqliu
commented
Nov 22, 2024
Contributor
Author
There was a problem hiding this comment.
renamed the old python-ci-docs.yml to python-release-docs.yml
Contributor
Author
There was a problem hiding this comment.
this will now run on every PR when there's a change in mkdocs/docs/
kevinjqliu
force-pushed
the
kevinjqliu/ci-check-mkdoc
branch
from
9d24bc4 to
13e558c
Compare
Contributor
Author
|
verified that CI breaks with bad doc changes https://github.com/apache/iceberg-python/actions/runs/11963956201/job/33355402732?pr=1360 |
Fokko
approved these changes
Nov 22, 2024
Contributor
Fokko
left a comment
Fokko
left a comment
There was a problem hiding this comment.
Thanks @kevinjqliu for fixing this, this looks great!
kevinjqliu
force-pushed
the
kevinjqliu/ci-check-mkdoc
branch
from
13e558c to
7a83695
Compare
This was referenced Nov 22, 2024
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 7, 2024
* add ci to release docs * run mkdocs in ci * use 3.12
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 7, 2024
* add ci to release docs * run mkdocs in ci * use 3.12
JE-Chen
pushed a commit
to JE-Chen/iceberg-python
that referenced
this pull request
Dec 23, 2024
* add ci to release docs * run mkdocs in ci * use 3.12
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 24, 2024
* add ci to release docs * run mkdocs in ci * use 3.12
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a new GitHub Action to run
mkdocs build --strictfor every PR.python-ci-docs.ymlwas previously used to release doc changes, it's copied over and renamed topython-release-docs.yml.python-ci-docs.ymlnow runsmkdocs build --strictfor every PR.When releasing docs, the
python-ci-docs.ymlGitHub Action uses--strict. This action is only triggered during the release process, which requires an ad-hoc fix, see #1334.iceberg-python/.github/workflows/python-ci-docs.yml
Line 42 in 7a83695
Lets make sure this is checked in new PRs